Skip to content

Update quickstart scripts#365

Draft
lukekim wants to merge 12 commits into
trunkfrom
lukim/spice-qa-trunk-replay
Draft

Update quickstart scripts#365
lukekim wants to merge 12 commits into
trunkfrom
lukim/spice-qa-trunk-replay

Conversation

@lukekim
Copy link
Copy Markdown
Contributor

@lukekim lukekim commented Mar 17, 2026

This pull request introduces new samples and improves documentation for connecting to Spice.ai Cloud from various SDKs and tools. The main focus is on providing clear quick start guides, environment variable configuration, and example scripts for cURL, Spice CLI, Go, .NET, Java, and Rust. The changes make it easier for developers to run SQL queries against Spice.ai Cloud and understand the required setup for each language/tool.

New Cloud Sample Scripts and Documentation

  • Added new curl-sample and spice-cli-sample directories with quick start scripts and detailed README guides for querying Spice.ai Cloud using cURL and Spice CLI, including manual command examples and endpoint configuration. [1] [2] [3] [4] [5] [6]

Improved SDK Sample Documentation

  • Updated README files for Go (gospice-sdk-sample), .NET (spice-dotnet-sdk-sample), Java (spice-java-sdk-sample), and Rust (spice-rs-sdk-sample) SDK samples to clearly separate local and cloud usage, add quick start sections, and show expected output/logs for each step. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14]

Cloud Environment Variable Support in SDK Samples

  • Refactored cloud sample code in Go (cloud/main.go), .NET (Cloud.cs), and Java (Cloud.java) to read API key and endpoint configuration from environment variables, improving usability and security for cloud connections. [1] [2] [3]

Build and Run Instructions for Multiple Languages

  • Enhanced build/run instructions in Java and Rust samples to include Maven, Gradle, and cargo workflows, as well as notes on required Java flags for Apache Arrow Flight compatibility. [1] [2] [3] [4] [5] [6]

Sample Output and Logs for User Guidance

  • Added sample output/logs in all SDK README files to help users verify correct execution and understand expected results when running local and cloud queries. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

lukekim added 3 commits March 16, 2026 18:37
…key and endpoints

- Removed hardcoded API keys and URLs in Go, .NET, Java, Python, and JavaScript samples.
- Added environment variable checks for SPICE_API_KEY, SPICE_HTTP_URL, and SPICE_FLIGHT_URL.
- Updated README files to reflect new usage instructions and prerequisites.
- Created new cloud query samples for Go and Python.
- Added default query script for CLI sample to demonstrate cloud querying.
- Improved error handling and output formatting across samples.
@lukekim lukekim changed the title Lukim/spice qa trunk replay Update quickstart scripts Mar 17, 2026
@lukekim lukekim marked this pull request as draft March 17, 2026 01:43
@lukekim lukekim self-assigned this Mar 17, 2026
@lukekim lukekim added the enhancement New feature or request label Mar 17, 2026
@lukekim lukekim added this to the v2.0 milestone Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant